CMake Qt Creator vendor presets

Specify Qt Creator preferences in the vendor section in CMakePresets.json and CMakeUserPresets.json.

CMake configuration presets

The following table summarizes the available presets.

An example of CMake configuration presets:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "AskBeforePresetsReload": false,
     "AskReConfigureInitialParams": false,
     "AutorunCMake": false,
     "PackageManagerAutoSetup": false,
     "ShowAdvancedOptionsByDefault": true,
     "ShowSourceSubFolders": false,
     "UseJunctionsForSourceAndBuildDirectories": true
   }
 }

To force a specific run device for a preset-based kit:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "runDevice": "GenericLinuxOsType"
   }
 }

Or to disambiguate among multiple devices of the same type:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "runDevice": {
       "type": "GenericLinuxOsType",
       "name": "my-raspberry-pi"
     }
   }
 }

The object form also supports specifying full device settings, which are used to create a device if no matching device exists:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "runDevice": {
       "type": "GenericLinuxOsType",
       "id": "MyRemoteDevice",
       "name": "my-raspberry-pi",
       "host": "192.168.1.100",
       "uname": "pi",
       "keyFile": "/home/user/.ssh/id_rsa",
       "sshPort": 22,
       "authentication": 1,
       "timeout": 5,
       "freePortsSpec": "8000-9000"
     }
   }
 }

Qt Creator looks for an existing device first by id, then by name. Only when neither matches does it add a new device, which then persists across sessions. Edit or remove it in Preferences > Devices > Devices, like any other device.

The following options are supported in the object form. They correspond to the SDK Tool addDev options of the same name, except where noted; for a complete reference, see addDev.

Build presets

The following table summarizes the available build presets.

An example of Qt Creator build preset vendor presets:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "useStaging": true,
     "stagingDir": "${sourceDir}/staging",
     "iOSAutomaticProvisioningUpdates": true,
     "clearSystemEnvironment": false
   }
 }

Run presets

Run presets provide settings for running applications built with CMake.

Each run setting has a target that matches a build target name. Qt Creator creates one run configuration per run setting and applies the settings to it. Where a run setting does not set displayName, the run configuration is named after the target, with a numeric suffix from the second run setting for that target onwards (for example, myApp, myApp2, myApp3).

Settings that the run configuration does not support are ignored. For example, useDyldSuffix has no effect unless you run the application locally on macOS.

Run presets also support utility targets (add_custom_target in CMake). For these targets, Qt Creator creates a run configuration that runs cmake --build . --target <targetName>. To specify a custom executable instead, use the executable field.

The following table summarizes the available run settings:

An example of Qt Creator run settings:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "runSettings": [
       {
         "target": "myApp",
         "displayName": "My App - production",
         "arguments": "--verbose --config production",
         "workingDirectory": "${sourceDir}/output",
         "useTerminal": false,
         "useLibraryPaths": true,
         "environment": {
           "MY_VAR": "my_value"
         }
       },
       {
         "target": "myApp",
         "displayName": "My App - debug",
         "arguments": "--debug",
         "workingDirectory": "${sourceDir}/debug-output",
         "useDyldSuffix": true,
         "useLibraryPaths": true,
         "active": true
       },
       {
         "target": "run-tests",
         "useTerminal": true
       },
       {
         "target": "shell",
         "displayName": "Interactive Shell",
         "executable": "/bin/bash",
         "arguments": "--help",
         "useTerminal": true
       }
     ]
   }
 }

This example creates four run configurations:

• "My App - production" (from the first run setting)
• "My App - debug" (from the second run setting, same target)
• run-tests (a utility target, runs cmake --build . --target run-tests)
• "Interactive Shell" (a standalone executable, runs /bin/bash)

Compiler presets

The following table summarizes the available presets.

For more information about compiler preferences, see Add compilers.

An example of Qt Creator compiler presets:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "compiler": {
       "c" : "$env{HOME}/llvm/mac/bin/clang",
       "cxx" : "$env{HOME}/llvm/mac/bin/clang++"
     }
   }
 }

Debugger presets

The following table summarizes the available presets.

For more information about debugger preferences, see Add debuggers.

An example of Qt Creator debugger presets:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "debugger": {
       "DisplayName": "GNU gdb 11.2.0 for MinGW 11.2.0 64-bit",
       "Abis": ["x86-windows-msys-pe-64bit"],
       "Binary": "C:/Qt/Tools/mingw1120_64/bin/gdb.exe",
       "EngineType": 1,
       "Version": "11.2.0"
     }
   }
 }

Qt version presets

The following table summarizes the available presets.

For more information about Qt version preferences, see Add Qt versions.

An example of Qt Creator Qt version presets:

 "vendor": {
   "qt.io/QtCreator/1.0": {
     "qt": "$env{HOME}/Qt/6.11.0/macos/bin/qmake"
   }
 }